/*
 *  Copyright 2001-2004 The Apache Software Foundation
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 */
package ar.uba.fi.posgrado.common.service;

import java.util.List;

import ar.uba.fi.posgrado.common.exception.PosgradoException;
import ar.uba.fi.posgrado.common.exception.PosgradoRuntimeException;
import ar.uba.fi.posgrado.common.exception.RepeatedNameException;
import ar.uba.fi.posgrado.common.model.Role;
import ar.uba.fi.posgrado.common.model.User;

/**
 * Servicio para manejar {@link User users}.<br>
 * 
 * @author nicolas.gonzalez
 */
public interface UserService {

	/**
	 * Obtiene un usuario por nombre de usuario.<br>
	 * 
	 * @param userName
	 * @return
	 * @throws PosgradoRuntimeException
	 * @throws PosgradoException
	 */
	public User getUserByName(String userName) throws PosgradoRuntimeException,
			PosgradoException;

	/**
	 * Crea un usuario en el sistema.<br>
	 * 
	 * @param user
	 * @throws PosgradoRuntimeException
	 * @throws RepeatedNameException
	 * @throws PosgradoException
	 */
	public void createUser(User user) throws PosgradoRuntimeException,
			RepeatedNameException, PosgradoException;

	/**
	 * Crea un usuario en el sistema utilizando los nombres de los roles
	 * recibidos<br>
	 * El usuario no esta creado, asi q previamente se obtiene.<br>
	 * 
	 * @param user
	 * @param roles
	 * @throws PosgradoRuntimeException
	 * @throws RepeatedNameException
	 * @throws PosgradoException
	 */
	public void createUser(User user, List<Role> roles)
			throws PosgradoRuntimeException, RepeatedNameException,
			PosgradoException;

	/**
	 * Modifica un usuario del sistema.<br>
	 * 
	 * @param user
	 * @throws PosgradoRuntimeException
	 * @throws PosgradoException
	 */
	public void modifyUser(User user) throws PosgradoRuntimeException,
			PosgradoException;

	/**
	 * Modifica un usuario del sistema seteandolo los roles recibidos.<br>
	 * 
	 * @param userName
	 *            Nombre
	 * @param roleNames
	 *            Nombres de roles
	 * @throws PosgradoRuntimeException
	 * @throws PosgradoException
	 */
	public void modifyUser(String userName, List<String> roleNames)
			throws PosgradoRuntimeException, PosgradoException;

	/**
	 * Modifica un usuario del sistema seteandolo los roles recibidos.<br>
	 * 
	 * @param user
	 *            Usuario
	 * @param roleNames
	 *            Nombres de roles
	 * @throws PosgradoRuntimeException
	 * @throws PosgradoException
	 */
	public void modifyUser(User user, List<Role> roles)
			throws PosgradoRuntimeException, PosgradoException;

	/**
	 * @return Todos los usuarios.<br>
	 * @throws PosgradoRuntimeException
	 * @throws PosgradoException
	 */
	public List<User> getAllUsers() throws PosgradoRuntimeException,
			PosgradoException;

	/**
	 * Borra un usuario.<br>
	 * 
	 * @param user
	 * @throws PosgradoRuntimeException
	 * @throws PosgradoException
	 */
	public void deleteUser(User user) throws PosgradoRuntimeException,
			PosgradoException;

	/**
	 * @param userName
	 *            Nombre de usuario
	 * @return Todos los roles disponibles para un usuario.<br>
	 * @throws PosgradoRuntimeException
	 * @throws PosgradoException
	 */
	public List<Role> getAvailableRolesForUser(String userName)
			throws PosgradoRuntimeException, PosgradoException;

	/**
	 * Devuelve todos los roles
	 * 
	 * @return Devuelve todos los roles
	 * @throws PosgradoRuntimeException
	 * @throws PosgradoException
	 */
	public List<Role> getAllRoles() throws PosgradoRuntimeException,
			PosgradoException;

	/**
	 * Devuelve una lista con roles correspondientes a los nombres que se le
	 * pasan en la lista
	 * 
	 * @param roleNames
	 * @return
	 * @throws PosgradoRuntimeException
	 * @throws PosgradoException
	 */
	public List<Role> getRolesByName(List<String> roleNames)
			throws PosgradoRuntimeException, PosgradoException;
	
	public boolean hasBodyRole(List<Role> roles);
	
}
